BBS Toolkit/BBS Toolkit.iso/programs/ratio111.zip/SPRATIO.DOC

Text File | 1993-01-20 | 13KB | 243 lines

              SPitfire RATIO checker/upgrader/degrader (SPRATIO)!

                              By John Pittman Jr.


   First the boring stuff:
       The author permits temporary rights to use  this program for a term of
   no more than thirty (30) days, provided that you do not use it in a manner
   that it is not intended, reverse  engineer, or otherwise alter the program
   or any of it's accompanying files in any way not intended.

       The author places  no guarantee on the operation  or integrity of this
   program and is and cannot  be held responsible for  damages or losses that
   occur from, during use of, or otherwise  related to this program. It is in
   plain sense that  this program  and it's counter-parts  are under an as is
   basis and you are to use this program at your own risk!! Over & Out!

    The good stuff:
       This program was  written for SPITFIRE  versions 3.x (ONLY tested with
   version 3.2) to  perform a READ of  the SPITFIRE user file  and perform an
   upload download ratio check on the level specified on the command line. It
   will adjust the users level to the violation level specified if the user's
   is in violation of the UL/DL Ratio. It will also adjust the users level to
   the good standing level if he/she is not in violation of the UL/DL Ratio.

       This program  was written to  take the pain out  of HAND-EXAMINING the
   users on my BBS in order  to upgrade their access if they are contributing
   as well as  recieving. And to degrade those  users who are in violation of
   the special ratio I have arranged.

       This program  is NOT intended to replace  the ratio checking that Mike
   Woltz has already placed  in the software (as it does just  about the same
   thing). This  just gives you the option  of having more  than one ratio so
   that users  who contribute more  than others can  be rewarded. And it adds
   A few more features described a bit more in detail below.


--[ FILES YOU SHOULD HAVE WITH THIS VERSION ]--------------------------------

   SPRATIO.EXE  - The MAIN program itself!!
   SPRATIO.DOC  - This file that you are reading right now.
   SPRATIO.CFG  - A SAMPLE configuration file. SEE CONFIGURATION BELOW!!
   EXEMPT.TXT   - A SAMPLE exemption file. SEE EXEMPTION OPTION BELOW!!
   ORDER.FRM    - The SHAREWARE order form to REGISTER this program
                  (It's cheap to register too!!!)


--[ SETTING IT UP]-----------------------------------------------------------

    1>    Copy ALL the files into their own directory.
    2>    Using an ASCII text editor, edit the path in the configuration file
          to reflect the location of your SPITFIRE user file.
          (Default file included is C:\SF\WORK\ )
    3>    Review the command line options below and enter them.
          If you'll be runing this as an EVENT then place this in your SF.BAT
          batch file under the event you want. For the proceedure on EVENT
          setup, see the documentation that came with your SPITFIRE BBS
          Software.

   That's it to the operation! EASY isn't it! That's the idea!


--[ COMMAND LINE ]-----------------------------------------------------------

   SPRATIO [LEVEL] [GOOD] [BAD] [UL/DL RATIO]

       LEVEL       = This is the level that you will be scaning
       GOOD        = This is the level the user is set to if he/she
                       IS NOT IN VIOLATION of the ratio
       BAD         = This is the level the user is set to if he/she
                       IS IN VIOLATION of the ratio
       UL/DL RATIO = This is the WARNING RATIO of uploads to downloads
                       for the level your trying to maintain!
                           (IE. If your BBS requires that the users who want
                           high access must strictly adhere to the 1 upload
                           to 2 downloads ratio, then set this to a 2 (yes,
                           the ratio is always in comparison to 1 upload!!).

 **NOTE - Your not supposed to include the brackets either, just a reminder!!


--[ CONFIGURATION ]----------------------------------------------------------

      The configuration file allows YOU, the operator, to specify the path of
   your SFUSERS.DAT file (including the final "\" backslash!). And whether or
   not you will be using an EXEMPTION  OPTION list as well as an ASCII output
   file that is in SPITFIRE FILE FORMAT including control characters to clear
   the screen,  and include  a <MORE>  prompt. You  can also  create listings
   of the users with their UPLOADS & DOWNLOADS listed or not listed. There is
   also a  feature that  allows you  to select  whether you  want to upgrade,
   degrade, or no adjust your users who have a ratio of zero uploads and zero
   downloads.


SAMPLE FILE:

C:\SF\WORK\     - Path to your SFUSERS.DAT file (INCLUDE THE LAST BACKSLASH!)
NO            * - YES/NO - Exemption Option List Toggle
YES           * - YES/NO - Write ASCII Output File Toggle
NO            * - YES/NO - DISPLAY ULDS & DLDS in ULCLL OPTION
NONE          * - DEGRADE/UPGRADE/NONE - 3-Way Toggle setting for 0:0 Ratios
3             * - Number of lines you will have in your OPTIONAL ENDER(3 Max)
....          * - Line 1 of ASCII text that will show up in OPTIONAL ENDER
....          * - Line 2 "    "    "    "    "    "   "  "     "       "
....          * - Line 3 "    "    "    "    "    "   "  "     "       "

 * - These options are ONLY AVAILABLE IN THE REGISTERED VERSION. You may omit
     these lines in the  SHAREWARE version if you  like. I recommend that you
     leave them there though.


--[ EXEMPTION OPTION ]-------------------------------------------------------

       The exemption  option file allows  YOU, the operator, to  omit certain
   users from being  examined if the  level you are checking  is the level of
   that user and you don't want that user's  level changed or altered at all.
   Names are entered ONE  per line followed by pressing  the ENTER key. Names
   format is that of SPITFIRE, the first letter of each word in the name must
   be a capital letter. For example,  Jerome Fletchbetter (Not an actual name
   I know of, but serves it's  purpose) would be entered just as it says. See
   the sample file I have included for a few more examples.


--[ ASCII OUTPUT DISPLAY FILE ]----------------------------------------------

       The ASCII  output file is  made from a  header, ALL  the modifications
   that are made to the  SPITFIRE users file, followed by a SHAREWARE ending.
   The file  that is  created  is straight  ASCII form  that is  used for ALL
   *.BBS screens  used in SPITFIRE . The filename is  ' SPRATIO.BBS '. If the
   file is already existant in the current  directory, it will be overwritten
   by the new one. In  order to use this file as  a display file on your BBS,
   you  will have  to follow  the command  line with  a copy to  the path and
   filename that you want the file to be named. An Example is below:

@ECHO OFF
CD\SPRATIO
SPRATIO 20 15 25 5
COPY SPRATIO.BBS C:\SF\DISPLAY\BULLET1.BBS
CD\SF

       The output  file also  has a  clear  screen control  character  in the
   begining and at  the end it  has the <MORE>  prompt control  characters to
   enable the prompt  and place the prompt on the  screen. That's it! You now
   have a bulletin for use on your bbs.

--[ 3-WAY 0:0 RATIO TOGGLE ]-------------------------------------------------

       The three-way  toggle  option  gives  you, the  sysop, the  ability to
   decide  how  you  want to  handle  your users  who  have  a  ratio  of 0:0
   ( 0 Uploads and 0 Downloads ). Upon locating a user whose ratio reflects a
   ratio of 0:0, it will either NOT ADJUST the users level, DEGRADE the users
   level ( To what was  specified on the command  line ),or UPGRADE the users
   level ( To what was specified on the command line ). See the Configuration
   information for how to set this option and where.


--[ OPTIONAL ENDER ]---------------------------------------------------------

       The OPTIONAL ENDER  gives you the ability  to follow your scanning and
   adjustments with  the BOX that follows  the SHAREWARE version,  but with a
   bit of a twist. You can have UP  TO 3 LINES ONLY, but you may use 2, or 1.
   The choice is  yours. Each line of text can be  up to but not exceeding 69
   letters.  Any letters  after  the  69th  character  will  be cut  off  and
   discarded.  The  text is  printed to the  screen and  to the ASCII  OUTPUT
   DISPLAY FILE as well. To disable  this feature, set the number of lines to
   the number 0  and it will eliminate the  ENDER completely  from the screen
   and the FILE. You MUST have  enough lines of text for the number you enter
   at NUMBER OF LINES  position. See CONFIGURATION  for the format and layout
   of this option.

 **NOTE - This OPTION IS NOT AVAILABLE in the SHAREWARE version. You will
          always get the SHAREWARE ENDER in an UNREGISTERED COPY!!


--[ USER LEVEL COMMAND LINE LISTING & THE ULCLL OPTION TOGGLE ]--------------

       I created this  option because  I thought that  maybe some of you were
   thinking, "Hmm..... It  displays the CHANGES  but why not make it have the
   ability to list ALL the users who have a certain level and show the number
   of uploads and downloads that person has made?". Well, I've done it and it
   too is very  easy to impliment.  Simply when you enter  the command on the
   command  line, enter  the level  you want to  list for ALL  three of these
   positions. For example, to list ALL the users of level 40 you'd type this,

    SPRATIO 40 40 40 1

       The last number is  for display purposes only. It  gets printed at the
   top in the  scaning message  stating what  the download  ratio is for that
   level! Don't forget that!! It's for display purposes and MUST be there for
   the message to make any sense  at all. This option does not write any data
   TO the SFUSERS.DAT  file at all. All  it will  do is read  the information
   from  the  file  and  display it  to the  screen  and  it  writes  to  the
   SPRATIO.BBS  file as  well. This makes  it convienient  for you  to create
   complete level listings of  your users and their upload & download counts.
   This option  is FREE to  ALL! But  the file  option is  still a REGISTERED
   OPTION You will be able to see on the screen who's at the level but not in
   any file. To use this option  multiple times and create many display files
   of your levels, you  will have to copy  the SPRATIO.BBS  file over to your
   display file, naming it something  different during the copy. Then you can
   execute the program again and follow the same proceedures.

      The listing  of the  upload and  download counts  for each  user can be
   disabled by setting the ULCLL OPTION TOGGLE (in the configuration file) to
   'NO'! If you  would like to have  them listed along  with the persons name
   and level then you will have to set the toggle to 'YES'!


--[ REGISTERED FEATURES ]----------------------------------------------------

       Features that you get when you register your version of SPRATIO are
   as follows:


    SPRATIO EXEMPTION LIST OPTION
    ASCII OUTPUT DISPLAY FILE
    3-WAY 0:0 RATIO TOGGLE
    OPTIONAL ENDER
    ULCLL OPTION TOGGLE


       These options are not available in the SHARWARE VERSION!!  If you like
   the speed  and accuracy  of SPRATIO, you  can register  the software and I
   will send to  you the current  REGISTERED  version tagged with  your name.
   Your name will appear  on the display screen during  execution and it will
   also appear in the ASCII output display file. See the file 'ORDER.FRM' for
   details and  more information  on what you  get and how  to order YOUR OWN
   version of SPRATIO (SPitfire RATIO!).


--[ PROBLEMS & OTHERS ]------------------------------------------------------

       For a  more current  version  or if  your  having  problems with  this
   program you can contact my BBS! The ABACUS BBS [phone] . And leave a
   comment to the SysOp!

                                                  Thanks & Enjoy!
                                                     - John Pittman

@January 8th, 1992 ----------------------------------------------------------